Mentions légales du service
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Chameleon
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Operate
Environments
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
solverstack
Chameleon
Commits
1d472c5c
Commit
1d472c5c
authored
8 years ago
by
PRUVOST Florent
Browse files
Options
Downloads
Patches
Plain Diff
add link to contributing.md and update section documentation
parent
57505b18
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README-dev.md
+35
-4
35 additions, 4 deletions
README-dev.md
with
35 additions
and
4 deletions
README-dev.md
+
35
−
4
View file @
1d472c5c
...
...
@@ -4,11 +4,11 @@ README for developers
This page is dedicated to rules and conventions that Chameleon's
developers must follow and that should be read by contributors.
Gitlab flow
Gitlab flow
: how to contribute to Chameleon
---------------------
TODO - Write here how to use git and gitlab to push modifications into
Chameleon.
Please read and follow guidelines given here:
https://gitlab.inria.fr/solverstack/chameleon/blob/master/CONTRIBUTING.md
### Update submodules
...
...
@@ -29,7 +29,38 @@ git push --recurse-submodules=check
Documentation
---------------------
TODO - Write here how to generate the documentation.
### Generate the documentation
#### Prerequisites
To generate the documentation you need to have
[
Doxygen
](
http://www.stack.nl/~dimitri/doxygen/
)
and
[
Texinfo
](
https://www.gnu.org/software/texinfo/
)
installed on your
system.
For example, on Debian systems:
```
#!shell
sudo apt install doxygen texinfo
```
#### configure + make documentation
Enter into the Chameleon's source root directory and configure with
*CHAMELEON_ENABLE_DOCS=ON*
, then generate the documentation with
`make
docs`
```
#!shell
cd chameleon
mkdir build && cd build
cmake .. -DCHAMELEON_ENABLE_DOCS=ON
make docs
```
### Rules about source code documentation
TODO - Write here the rules to document source code inside chameleon.
Packaging
---------------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment