Skip to content

Commit f7f2f05

Browse files
committed
Update README.
1 parent 73cee03 commit f7f2f05

File tree

1 file changed

+4
-38
lines changed

1 file changed

+4
-38
lines changed

README.md

Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,7 @@
1-
# libpypeg - A C library
1+
# libpypeg - The Python PEG Parser as a C++ library
22

3-
The `libpypeg` C library provides <SUMMARY-OF-FUNCTIONALITY>.
3+
## License
44

5+
Any parts that are directly copies from [C Python](https://github.com/python/cpython) are covered by the [Python license](https://github.com/python/cpython/blob/main/LICENSE).
56

6-
## Usage
7-
8-
To start using `libpypeg` in your project, add the following `depends`
9-
value to your `manifest`, adjusting the version constraint as appropriate:
10-
11-
```
12-
depends: libpypeg ^<VERSION>
13-
```
14-
15-
Then import the library in your `buildfile`:
16-
17-
```
18-
import libs = libpypeg%lib{<TARGET>}
19-
```
20-
21-
22-
## Importable targets
23-
24-
This package provides the following importable targets:
25-
26-
```
27-
lib{<TARGET>}
28-
```
29-
30-
<DESCRIPTION-OF-IMPORTABLE-TARGETS>
31-
32-
33-
## Configuration variables
34-
35-
This package provides the following configuration variables:
36-
37-
```
38-
[bool] config.libpypeg.<VARIABLE> ?= false
39-
```
40-
41-
<DESCRIPTION-OF-CONFIG-VARIABLES>
7+
For all other code, the copyright is held by the Rubinius Contributors and licensed under [BSD 3-clause](/LICENSE).

0 commit comments

Comments
 (0)