Skip to content

Commit 8faf5e0

Browse files
committed
README: Use atx-style headers for a more compact notation
1 parent 8dd1fc5 commit 8faf5e0

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

README.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Python SPDX Library to parse, validate and create SPDX documents
2-
==========================
1+
# Python SPDX Library to parse, validate and create SPDX documents
32

43
This library implements an SPDX tag/value and RDF parser, validator and handler in Python.
54
This is the result of an initial GSoC contribution by @ah450 https://github.com/ah450 and
@@ -12,28 +11,25 @@ Issues: https://github.com/spdx/tools-python/issues
1211
Pypi: https://pypi.python.org/pypi/spdx-tools
1312

1413

15-
License:
16-
========
14+
# License
1715

1816
Apache-2.0
1917

2018

21-
Features:
22-
==================
19+
# Features
2320

2421
* API to create and manipulate SPDX documents.
2522
* Parse and create Tag/Value format SPDX files
2623
* Parse and create RDF format SPDX files
2724

2825

29-
TODOs:
30-
======
26+
# TODOs
3127

3228
* Update to full SPDX v2.1
3329
* Add to full license expression support
3430

35-
How to use:
36-
===========
31+
32+
# How to use
3733

3834
Example tag/value parsing usage:
3935
```Python
@@ -68,30 +64,26 @@ The `examples` directory contains several code samples:
6864
`python pp_rdf.py data/SPDXRdfExample.rdf pretty.rdf`
6965

7066

71-
Installation:
72-
=============
67+
# Installation
7368

7469
Clone or download the repository and run `python setup.py install`. (In a virtualenv, of course)
7570

7671
or install from Pypi with `pip install spdx-tools`
7772

7873

79-
How to run tests:
80-
=================
74+
# How to run tests
8175

8276
From the project root directory run: `python setup.py test`.
8377
You can use another test runner such as pytest or nose at your preference.
8478

8579

86-
Dependencies:
87-
=============
80+
# Dependencies
8881

8982
* PLY : https://pypi.python.org/pypi/ply/ used for parsing.
9083
* rdflib : https://pypi.python.org/pypi/rdflib/ for for handling RDF.
9184

9285

93-
Support:
94-
=======
86+
# Support
9587

9688
* Submit issues, questions or feedback at: https://github.com/spdx/tools-python/issues
9789
* Join the dicussion on https://lists.spdx.org/mailman/listinfo/spdx-tech and

0 commit comments

Comments
 (0)