Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add quickstart section to docs #21

Merged
merged 1 commit into from
May 8, 2019
Merged

Add quickstart section to docs #21

merged 1 commit into from
May 8, 2019

Conversation

bmorcos
Copy link
Contributor

@bmorcos bmorcos commented May 7, 2019

Motivation and context:

Give the people what they want! everybody loves a good quickstart guide.

Interactions with other PRs:

How has this been tested?

One scripted example was added, works fine with both boards.

How long should this take to review?

  • Quick (less than 40 lines changed or changes are straightforward)

Where should a reviewer start?

Take a look at the new documentation and try running the new scripted example.

Types of changes:

  • Non-code change (touches things like tests, documentation, build scripts)

Checklist:

  • I have read the CONTRIBUTING.rst document.
  • I have updated the documentation accordingly.
  • I have included a changelog entry.
  • I have tested this with all supported devices.
  • N/A I have added tests to cover my changes.
  • N/A I have run the test suite locally and all tests passed.

Still to do:

Do we want to add plots or printing to the script example? Right now it runs but doesn't really appear to do anything since we don't plot or print outputs.

Copy link
Member

@xchoo xchoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor edit. Otherwise, looks good.

- Fixes 17
- Updated hw section in appendix since we no longer sell boards
- Added a scripted NengoFPGA example
- Added a bitstream section to point to device-specific docs
- Add some detail to the Device ID section
- Fix email on contact us page
@bmorcos bmorcos merged commit 56bbc70 into master May 8, 2019
@bmorcos bmorcos deleted the quickstart branch May 8, 2019 21:09
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants