Skip to content

Commit

Permalink
Fix URL for badges and project structure description in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
kartikkumar committed Aug 16, 2018
1 parent a11a5ae commit 2f61ce1
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
sml
===

\cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/openastro/sml.svg?branch=master)](https://travis-ci.org/openastro/sml) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3666/badge.svg)](https://scan.coverity.com/projects/3666) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/sml/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/sml?branch=master) \endcond
\cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/kartikkumar/sml.svg?branch=master)](https://travis-ci.org/kartikkumar/sml) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3666/badge.svg)](https://scan.coverity.com/projects/3666) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/sml/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/sml?branch=master) \endcond

SML (Simple Mathematics Library) is a C++ (template) library that provides basic mathematics functionality. The library is intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include SML in other CMake-based projects: [Findsml.cmake](https://github.com/openastro/cmake-modules/blob/master/Modules/Findsml.cmake).

Expand Down Expand Up @@ -74,8 +74,7 @@ Project structure
This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:

- `cmake/Modules` : Contains `CMake` modules, including `Findsml.cmake` module
- `docs`: Contains project-specific docs in [Markdown](https://help.github.com/articles/github-flavored-markdown/ "GitHub Flavored Markdown") that are also parsed by [Doxygen](http://www.doxygen.org "Doxygen homepage"). This sub-directory includes `global_todo.md`, which contains a global list of TODO items for project that appear on TODO list generated in [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
- `doxydocs`: HTML output generated by building [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
- `docs`: Contains code documentation generated by [Doxygen](http://www.doxygen.org "Doxygen homepage")
- `include/sml`: Project header files (*.hpp)
- `scripts`: Shell scripts used in [Travis CI](https://travis-ci.org/ "Travis CI homepage") build
- `test`: Project test source files (*.cpp) that are provided to the [Catch2](https://github.com/catchorg/Catch2 "Catch2 Github repository") framework
Expand Down

0 comments on commit 2f61ce1

Please sign in to comment.