Skip to content

Commit

Permalink
Merge pull request #14 from kaushalmodi/fix-CI-badge-URLs
Browse files Browse the repository at this point in the history
Fix ci badge URLs
  • Loading branch information
Clonkk authored Jun 27, 2021
2 parents 94b3c12 + 08b3d31 commit 29777c7
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Nim bindings for the C++ STL

![workflow](https://github.com/SciNim/nimfftw3/actions/workflows/ci.yml/badge.svg)
![workflow](https://github.com/SciNim/nimfftw3/actions/workflows/docs.yml/badge.svg)
![workflow](https://github.com/Clonkk/nim-cppstl/actions/workflows/ci.yml/badge.svg)
![workflow](https://github.com/Clonkk/nim-cppstl/actions/workflows/docs.yml/badge.svg)

## Introduction

This library is a Nim wrapper for C++ Standard Template Library (STL) class.
This library is a Nim wrapper for C++ Standard Template Library (STL) class.
**This library is obviously only compatible with the C++ backend**

I recommand using this bindings only in two cases:
Expand All @@ -15,7 +15,9 @@ I recommand using this bindings only in two cases:

## Installation

``nimble install cppstl``
```
nimble install cppstl
```

Add the following lines to your `.nimble`:
```
Expand All @@ -25,7 +27,7 @@ requires "cppstl"

## Limitations

``cppstl`` currently wraps :
``cppstl`` currently wraps :

* ``std::string``
* ``std::std_vector``
Expand All @@ -37,15 +39,28 @@ requires "cppstl"

## Contributions

All contributions are welcome !
If there is a missing function or class, that you need, don't be shy to open an issue or a PR.
All contributions are welcome!

If there is a missing function or class, that you need, don't be shy to open an issue or a PR.

### Running Tests

```
nimble test
```

or

```
testament p "tests/t*.nim"
```

## Usage

The documentation is here : https://clonkk.github.io/nim-cppstl/cppstl.html

You can find more use-case in the ``tests`` folder.
You can find more use-case in the `tests` folder.

## License

This code is licensed under MIT license (see LICENSE.txt for details)
This code is licensed under MIT license (see [LICENSE.txt](./LICENSE.txt) for details)

0 comments on commit 29777c7

Please sign in to comment.