Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ddp5730 committed Sep 22, 2021
1 parent f65efc8 commit 50f4bce
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[submodule "libs/EVT-core"]
path = libs/EVT-core
url = ../EVT-core.git
# Need to set the full url if not cloned into the EVT organization
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,28 @@ hosted on `readthedocs.io`

## Steps to Setup a New Project

// TODO

1)
1) Create a new repo based on the project-template
1) From [project-template](https://github.com/RIT-EVT/project-template) click `Use this template`
2) Choose a repo name and make sure it's public for auto-documentation to work
3) If the owner is not set to RIT-EVT then you need to update the .gitmodules file URL
2) Clone the new repo
1) `git clone <URL>`
3) Update the EVT submodule
1) `git submodule update --init --recusive && git pull`
2) The above command can be used at any point to update the submodule from remote
4) Import the project into Read the Docs
1) Log in to [readthedocs.io](https://readthedocs.org/)
2) Navigate to dashboard page
3) Import the Repository. Follow instructions on webpage
5) Update all instances of BOARD_NAME to match your project name
1) `CMakeLists.txt:15`
2) Directory `./include/BOARD_NAME`
3) Directory `./source/BOARD_NAME`
4) Directory `./targets/BOARD_NAME`; also update `targets/CMakeLists.txt`
5) `docs/Doxyfile:35`
6) `docs/source/index.rst:6`
7) `docs/source/api/index.rst`
6) Sample files are included in `./src` and `./include`. These files can likely be removed and
updates made accordingly. There are placeholders to demonstrate the board library building
functionality.

2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. EVT-core documentation master file, created by
.. Documentation master file, created by
sphinx-quickstart on Sat Sep 4 10:17:15 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down

0 comments on commit 50f4bce

Please sign in to comment.