Kaynağa Gözat

Rename to shellfu: Update docs and notes

Alois Mahdal 8 yıl önce
ebeveyn
işleme
0a7a54ca84
6 değiştirilmiş dosya ile 27 ekleme ve 29 silme
  1. 3
    5
      README.md
  2. 3
    3
      notes/TODO.md
  3. 6
    6
      notes/guidelines.md
  4. 11
    11
      notes/packaging.md
  5. 1
    1
      notes/progress.md
  6. 3
    3
      notes/style.md

+ 3
- 5
README.md Dosyayı Görüntüle

@@ -1,9 +1,7 @@
1
-Fastfoo Bash library
2
-=====================
1
+Shellfu Bash library
2
+====================
3 3
 
4
-ffoo - Fastfoo - Bash dot on steroids
5
-
6
-**Make your foo taste like real foo.  Fast.**
4
+Shellfu - Bash dot on steroids
7 5
 
8 6
 
9 7
 NOTES

+ 3
- 3
notes/TODO.md Dosyayı Görüntüle

@@ -11,10 +11,10 @@ global/misc
11 11
     automatic mktemp/pushd/cp/popd/rmrf wrappng (make friends with
12 12
     collect_artifact*)
13 13
 
14
-*   fix up `ffoo --list-*`, current implementation is
14
+*   fix up `shellfu --list-*`, current implementation is
15 15
     scratching right ear with left hand
16 16
 
17
-*   support conflict checking in `ffoo`. i.e. for TI and the likes
17
+*   support conflict checking in `shellfu`. i.e. for TI and the likes
18 18
 
19 19
 *   doc - finish `ffdoc`, add first line to function lists
20 20
 
@@ -25,7 +25,7 @@ global/misc
25 25
 
26 26
 *   separate core libs and extras
27 27
 
28
-*   maybe separate ffoo from core libs
28
+*   maybe separate shellfu from core libs
29 29
 
30 30
 
31 31
 test

+ 6
- 6
notes/guidelines.md Dosyayı Görüntüle

@@ -52,7 +52,7 @@ API
52 52
     success or error type
53 53
 
54 54
 *   use 1 for "no", 2 for syntax error (if applicable), more
55
-    otherwise;  note that ffoo pretty.die uses 9 as a generic
55
+    otherwise;  note that shellfu pretty.die uses 9 as a generic
56 56
     status
57 57
 
58 58
 
@@ -66,18 +66,18 @@ API
66 66
 
67 67
 ### Variables ###
68 68
 
69
-*   module "bar" has implicitly reserved namespace "FFOO_BAR* and "__FOO_BAR*"
69
+*   module "bar" has implicitly reserved namespace "SHELLFU_BAR* and "__FOO_BAR*"
70 70
 
71
-*   few exceptions exist like FFOO_DEBUG, where Fastfoo itself reserves
71
+*   few exceptions exist like SHELLFU_DEBUG, where Fastfoo itself reserves
72 72
     a module name
73 73
 
74 74
 *   always consider
75 75
 
76
-        FFOO_BAR_BAZ=${FFOO_BAR_BAZ:-value}
76
+        SHELLFU_BAR_BAZ=${SHELLFU_BAR_BAZ:-value}
77 77
 
78 78
     over
79 79
 
80
-        FFOO_BAR_BAZ="value"
80
+        SHELLFU_BAR_BAZ="value"
81 81
 
82 82
     since in the first case user can set this (in-line when calling your
83 83
     script or globally in .bashrc)
@@ -98,7 +98,7 @@ Echo to stdout only if purpose of your script/function **is** to print
98 98
 **that** text.  Otherwise use `think()` instead.
99 99
 
100 100
 If you want to make your script "user-friendly" (like babbling about
101
-what it's doing), consider setting `FFOO_VERBOSE` to true in header of
101
+what it's doing), consider setting `SHELLFU_VERBOSE` to true in header of
102 102
 your script (and implementing `-q|--quiet` to tun it off).
103 103
 
104 104
 

+ 11
- 11
notes/packaging.md Dosyayı Görüntüle

@@ -11,29 +11,29 @@ Exposing sub-sets as  not supported
11 11
 "Leaf" packages
12 12
 ---------------
13 13
 
14
- *  *ffoo-base* - only ffoo.sh (posix)
15
- *  *ffoo-core* - core libs (posix?)
16
- *  *ffoo-extras* - extra libs
17
- *  *ffoo-manpages* - manpages (extra because of req. ronn to build)
14
+ *  *shellfu-base* - only shellfu.sh (posix)
15
+ *  *shellfu-core* - core libs (posix?)
16
+ *  *shellfu-extras* - extra libs
17
+ *  *shellfu-manpages* - manpages (extra because of req. ronn to build)
18 18
 
19 19
 
20 20
 Meta packages
21 21
 -------------
22 22
 
23
- *  *ffoo* - -base, -core, -extras, -manpages (not -desktop)
24
- *  *ffoo-posix* - -base plus libs compliant with posix
23
+ *  *shellfu* - -base, -core, -extras, -manpages (not -desktop)
24
+ *  *shellfu-posix* - -base plus libs compliant with posix
25 25
 
26 26
 
27 27
 Package contents
28 28
 ----------------
29 29
 
30 30
 
31
-### ffoo-base ###
31
+### shellfu-base ###
32 32
 
33
-No modules, just ffoo.sh and supporting binaries.
33
+No modules, just shellfu.sh and supporting binaries.
34 34
 
35 35
 
36
-### ffoo-core ###
36
+### shellfu-core ###
37 37
 
38 38
  *  error
39 39
  *  pretty
@@ -43,12 +43,12 @@ No modules, just ffoo.sh and supporting binaries.
43 43
  *  types
44 44
 
45 45
 
46
-### ffoo-testing ###
46
+### shellfu-testing ###
47 47
 
48 48
  *  testing
49 49
 
50 50
 
51
-### ffoo-extras ###
51
+### shellfu-extras ###
52 52
 
53 53
  *  ini
54 54
  *  stats

+ 1
- 1
notes/progress.md Dosyayı Görüntüle

@@ -12,7 +12,7 @@ Done
12 12
  *  iniread
13 13
  *  artifacts
14 14
  *  ffdoc
15
- *  ffoom catfun
15
+ *  shellfu-get catfun
16 16
  *  charmenu
17 17
  *  tmp
18 18
  *  common exit statuses

+ 3
- 3
notes/style.md Dosyayı Görüntüle

@@ -73,9 +73,9 @@ Imports come *after* module docstring, *before* variable declarations.
73 73
     # A modest module
74 74
     #
75 75
 
76
-    ffoo import config
77
-    ffoo import exit
78
-    ffoo import pretty
76
+    shellfu import config
77
+    shellfu import exit
78
+    shellfu import pretty
79 79
 
80 80
     #
81 81
     # Some var