Skip to content

Commit 9fff38c

Browse files
committed
Add README with the background and process proposal
1 parent 345c715 commit 9fff38c

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# The OpenSC wiki
2+
3+
This is an OpenSC wiki. Authoritative source for the wiki rendered on Github
4+
OpenSC repository:
5+
6+
https://github.com/OpenSC/OpenSC/wiki
7+
8+
## Why?
9+
10+
It used to be accessible for everyone to edit, until we got some malicious
11+
actors trying to sneak in malware download links.
12+
13+
Now, it lives in separate repository https://github.com/OpenSC/Wiki where
14+
we accept contributions through pull requests.
15+
16+
## How to update wiki
17+
18+
### Contributors
19+
20+
Open a pull request with your changes as you would do with your code changes
21+
in this repository.
22+
23+
Do not use the "Edit" button on the wiki pages directly (accessible only for
24+
project members now).
25+
26+
### Maintainers
27+
28+
This git repository is an authoritative source of truth. Do NOT use the Edit
29+
button on the wiki.
30+
31+
Once the commit is merged to this repository, it needs to be manually pushed
32+
to the OpenSC wiki. Recommended approach is to configure the opensc wiki
33+
remote in your git client:
34+
```
35+
git remote add opensc.wiki https://github.com/OpenSC/OpenSC.wiki.git
36+
```
37+
and once there is a change, pull it locally and push it to the opensc.wiki
38+
```
39+
git pull origin
40+
git push opensc.wiki
41+
```
42+
43+
If the branches diverge for some reason, please investigate where did the
44+
changes come from and sync the repositories.

0 commit comments

Comments
 (0)