Skip to content

Commit 413bd8d

Browse files
committed
Update README.md
Added MarkDown information
1 parent 3cb7680 commit 413bd8d

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# Reference-Material
2-
This repository contains the reference material related to the OpenChain Project
2+
This repository contains the reference material related to the OpenChain Project. There are around 1,000 documents in this reference library at the moment. These documents are in various formats.
3+
4+
The OpenChain Education Work Group is working on making it easier to access, convert and share key reference material.
5+
6+
We plan to do this through providing the source material in MarkDown. People can change it into PDF documents, Word documents and other formats from there.
7+
8+
The reason for this change is to allow people to easily contribute to our editing via our Reference Library. This is hosted on GitHub and it favors formats like MarkDown that are basically text.
9+
10+
Our first step is to convert some existing documents into MarkDown. This will allow us to begin editing and updating them.
11+
12+
There is an online tool to convert Word documents to MarkDown, which is the first step of the process. You will find it here:
13+
<https://word2md.com>
14+
15+
Our Reference Library is here:
16+
<https://github.com/OpenChain-Project/Reference-Material>
17+
18+
It contains a lot of documents so we will narrow down the documents we want help with. Let’s start with some Word documents.
19+
20+
Here is our self-certification questionnaire: <https://github.com/OpenChain-Project/Reference-Material/blob/master/Self-Certification-Questionnaire/Official/2.1/en/OpenChain%20Self-Certification%20Questionnaire%202021-11-26.docx>
21+
22+
23+
Here is a conformance checklist:
24+
<https://github.com/OpenChain-Project/Reference-Material/blob/master/Checklists/Official/Conformance-Checklist/2.0/en/Conformance-Compliance-Checklist.docx>
25+
26+
Here is a document about using OpenChain in Mergers and Acquisitions:
27+
<https://github.com/OpenChain-Project/Reference-Material/blob/master/Guides/Official/OpenChain-in-Mergers-and-Acquisitions/2.0/en/Assessment-Of-OS-Practices-In-Merger-and-Acquisition.docx>
28+
29+
Here is a document to help managers understand OpenChain:
30+
<https://github.com/OpenChain-Project/Reference-Material/blob/master/Guides/Official/OpenChain-For-Managers/2.0/en/OpenChain%20For%20Managers%20-%20Version%201.0.docx>
31+
32+
If you convert one of these documents to MarkDown, please open a Pull Request to submit the updated document. If you need help with that, please ask our education work group at this mailing list:
33+
<https://lists.openchainproject.org/g/education/messages>
34+
35+
Now you can help with updating the documentation! The process is the same. Update the MarkDown and submit a pull request.
36+
37+
There is a small learning curve to take part in this new drive. However, it is quick, easy and free to get a graphical editor for MarkDown. Download it here:
38+
<https://panwriter.com>
39+
40+
Then download background tools for MarkDown:
41+
<https://pandoc.org/installing.html>
42+
43+
That’s it! You are ready to help. We look forward to working together to make sure even more people can take advantage of our reference library as they work towards a more trusted, more efficient and more effective supply chain.

0 commit comments

Comments
 (0)