Browse Source

Add basic readme

master
Jean-Sébastien 2 years ago
parent
commit
85bda88268
2 changed files with 44 additions and 2 deletions
  1. 0
    2
      README.md
  2. 44
    0
      readme.org

+ 0
- 2
README.md View File

@@ -1,2 +0,0 @@
1
-# pqed_html
2
-

+ 44
- 0
readme.org View File

@@ -0,0 +1,44 @@
1
+
2
+
3
+
4
+* Pre-Quantum Electrodynamics lecture notes (html export)
5
+
6
+In this repo, you will find
7
+`J.-S. Caux <https://jscaux.org>`_'s
8
+`Pre-Quantum Electrodynamics <https://jscaux.org/ln/pqed>`_
9
+online lecture notes (exported to html).
10
+
11
+** Pulling the notes to your local machine
12
+
13
+On the command line,
14
+#+BEGIN_SRC shell
15
+  git clone https://jscaux.org/git/jscaux/pqed_html.git
16
+#+END_SRC
17
+This will create a directory =pqed_html=. If you prefer pulling into
18
+a differently-named directory (/e.g./ =my_pqed_dir=), just do
19
+#+BEGIN_SRC shell
20
+  git clone https://jscaux.org/git/jscaux/pqed_html.git my_pqed_dir
21
+#+END_SRC
22
+
23
+Make sure you regularly pull the latest version
24
+(updates are frequently pushed; check the =Created= date at the
25
+bottom of the page to see which version you're using):
26
+#+BEGIN_SRC shell
27
+  cd pqed_html
28
+  git pull origin master
29
+#+END_SRC
30
+
31
+** Using the notes locally
32
+
33
+Pretty easy: just open the =index.org= page (or any other
34
+=.html= page in the repo) in your browser.
35
+
36
+
37
+** Learning git
38
+
39
+`git <https://git-scm.com/>`_ is one of those applications which
40
+you don't know you need until you start using it, after which you
41
+wonder how you could possibly have survived without it in the past.
42
+
43
+Though you don't need anything more than the instructions above,
44
+it's well worth your while to `RTFM <https://git-scm.com/doc>`_.

Loading…
Cancel
Save