Skip to content

Commit

Permalink
Merge pull request #57 from jberlin/master
Browse files Browse the repository at this point in the history
link to v3 FAQ docs
  • Loading branch information
jberlin committed Aug 24, 2016
2 parents 743f732 + 4937f20 commit 92f9f40
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 4 deletions.
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,42 @@
# Contributing

We welcome pull requests with code improvements from anyone, as long as they are consistent with our design philosophy, and are code reviewed and tested.

Please refer to our 'wishlist' issues for [needed code improvements][wishlist].
[wishlist]: https://github.com/wdas/SeExpr/issues?q=is%3Aissue+is%3Aopen+label%3Awishlist

To work in the SeExpr code base:

Fork, then clone the repo:

git clone git@github.com:your-username/SeExpr.

Set up your machine:

cd SeExpr
make install

Make sure the tests pass:

tbd

Make your change. Add tests for your change. Make the tests pass:

tbd

Push to your fork and [submit a pull request][pr].

[pr]: https://github.com/wdas/SeExpr/compare/

We will strive to at least comment on pull requests within three business days. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

* Address issues tagged in our 'wishlist'
* Write tests.
* Comment code changes.
* Write a good commit message.

# Additional Resources

* [Doxygen classes](http://wdas.github.io/SeExpr/doxygen/)
11 changes: 9 additions & 2 deletions README
@@ -1,14 +1,21 @@

===================================================================
SeExpr - An embeddable expression evaluation engine
For info on using new v3 features and porting your code, see:

http://wdas.github.io/SeExpr/doxygen/html/SeExpr_FAQ.html
===================================================================


===================================================================
SeExpr - An embeddable expression evaluation engine
===================================================================

Super impatient CMake building and installing guide
===================================================
$ git clone https://github.com/wdas/SeExpr
$ cd SeExpr
$ mkdir build
$ cd build
$ cd build
$ cmake ../
$ make doc # optional make documentation
$ make install
Expand Down
5 changes: 3 additions & 2 deletions src/doc/main.txt
Expand Up @@ -18,8 +18,9 @@
* \mainpage SeExpr
* \image html seexprlogo.png
* \section maindoc User and Programmer Tutorials
* - \subpage userdoc - User Documentation
* - \subpage userdoc
* - \subpage plugins - Custom Function Plugins
* - <a class="el" href="./html/SeExpr_FAQ.html">New v3 FAQ</a>
* \section demos Demo Applications
* - \subpage mytut (code at asciiGraph.cpp)
* - \subpage uitut (code at imageEditor.cpp)
Expand All @@ -44,7 +45,7 @@
*
* \section Other
* - \subpage license
* - <a href="./v1/index.html">Older Documentation (v1-v2)</a>
* - <a class="el" href="./v1/index.html">Older Documentation (v1-v2)</a>
*/

/**
Expand Down

0 comments on commit 92f9f40

Please sign in to comment.