Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cibinjoseph committed Feb 23, 2021
1 parent 122b829 commit d55b11c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ naturalFRUIT has been tested to work with gfortran and ifort for all versions of
All contributions are to be made to the `dev` branch through pull requests. The `master` branch is kept aside for releases.

### Creating documentation
For adding new documentation,
1. Fork this repo.
2. FORD parses comments with the marks *!!* in the source code and the folder *ford_input/* for creating documentation. Make the necessary changes.
4. Run the bash script `createDocs.sh` in the topmost directory of the repo to make FORD autocreate the documentation webpages.
5. Commit all changes.
6. Send a pull request.
For adding new documentation,
1. Fork this repo.
2. FORD parses comments with the marks *!!* in the source code and contents of the folder *ford_input/* for creating documentation.
3. Make the necessary changes.
4. Run the bash script `createDocs.sh` in the topmost directory of the repo to make FORD autocreate the documentation webpages.
5. Commit all changes.
6. Send a pull request.

## License
[BSD-3-Clause](LICENSE)
Expand Down
8 changes: 4 additions & 4 deletions media/naturalFRUIT-logo-short.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d55b11c

Please sign in to comment.