Skip to content

Commit 55ec16f

Browse files
committedJun 17, 2023
Enhance README
1 parent b9dab7a commit 55ec16f

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed
 

‎README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
Code example manager (CEM) is a software managing your notes, scripts and code examples.
44
It provides publish mechanisms to [github.com][githubcom] (as [gists][gists]) or
55
[gitlab.com][gitlabcom] (as [snippets][snippets]). It also automates execution for
6-
testable examples this is a quite useful when you have to deal with many examples.
6+
testable examples, this is a quite useful to manage a high number of examples.
77

88
All my notes, scripts and code examples (my programming knowledge base) are now managed using this tool,
99
you can take a look to **[my public gists overview on github][mygists]** to illustrate the
1010
publishing work achieved by CEM.
1111

12-
![](images/cloudtags.png)
13-
1412
Current [Code example manager (CEM)][cem] implementation is just a command line tool
1513
which compare locally available examples with already published ones in order to find
1614
what it should do (add, update, do nothing).
1715

16+
![](images/cloudtags.png)
17+
1818
## Why ?
1919

2020
Code examples are very important, each example is most of the time designed to focus
@@ -28,7 +28,10 @@ Managing hundreds of published code example files as gists (github) and/or snipp
2828
is really not easy and time-consuming, in particular if you want to keep them up to date. This
2929
is the main issue addressed by this software.
3030

31-
![](images/created-examples-trend.png)
31+
- My open-source examples evolution trend :
32+
![](images/created-examples-trend.png)
33+
- And for those who are executable/testable :
34+
![](images/testable-examples-status.png)
3235

3336
As you can see through the previous charts, once you have industrialized your notes and code
3437
examples, analytics on your examples become quite easy, and a lot of advanced features become
@@ -62,7 +65,7 @@ Instructions example with github.com publishing configuration :
6265
```
6366
- Run the following command from your terminal (`cs` is the [coursier][cs] CLI command):
6467
```
65-
cs launch fr.janalyse:code-examples-manager_3:2.2.0
68+
cs launch fr.janalyse:code-examples-manager_3:2.4.0
6669
```
6770
- you can even use `cs launch fr.janalyse:code-examples-manager_3:latest.release` to always use the latest release
6871
- current release is : [![][CodeExamplesManagerImg]][CodeExamplesManagerLnk]

‎images/cloudtags.png

-3.16 KB
Loading

‎images/created-examples-trend.png

3.63 KB
Loading

‎images/testable-examples-status.png

36 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.