commit f632533e07e690b5a297b9743f1096ce80d91062
parent cb56bb9caa517863be07b1afa6c2259077b2bec7
Author: Brook Jeynes <jeynesbrook@gmail.com>
Date: Tue, 20 Aug 2024 18:06:28 +1000
Update and rename README to README.md
Diffstat:
| D | README | | | 59 | ----------------------------------------------------------- |
| A | README.md | | | 57 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 57 insertions(+), 59 deletions(-)
diff --git a/README b/README
@@ -1,59 +0,0 @@
-progress
-========
-
-A simple thread safe progress bar and spinner library.
-
-Adding to your program
-----------------------
-1. Fetch the package.
- `zig fetch --save git+https://github.com/BrookJeynes/progress`
-2. Add to your `build.zig`.
- ```
- const progress = b.dependency("progress", .{}).module("progress");
- exe.root_module.addImport("progress", progress);
- ```
-
-Minimal example
----------------
-```zig
-const std = @import("std");
-const ProgressBar = @import("progress").Bar;
-const ProgressSpinner = @import("progress").Spinner;
-
-pub fn bar() !void {
- const stdout = std.io.getStdOut().writer();
- var pb = ProgressBar.init(10, stdout.any(), .{});
-
- while (!pb.isFinished()) {
- pb.add(1);
- try pb.render();
-
- std.time.sleep(std.time.ns_per_ms * 150);
- }
-}
-
-pub fn spinner() !void {
- const stdout = std.io.getStdOut().writer();
- var ps = ProgressSpinner.init(stdout.any(), .{
- .symbols = ProgressSpinner.PredefinedSymbols.default,
- });
-
- var iterations: usize = 0;
- while (!ps.isFinished()) {
- iterations += 1;
- try ps.render();
-
- if (iterations == 20) try ps.finish();
-
- std.time.sleep(std.time.ns_per_ms * 150);
- }
-}
-```
-
-You can find more examples in the `examples/` folder.
-For more information, see the source code or documentation (`zig build docs`).
-
-Contributing
------------
-Contributions, issues, and feature requests are always welcome! This project is
-using the latest stable release of Zig (0.13.0).
diff --git a/README.md b/README.md
@@ -0,0 +1,57 @@
+# progress
+
+A simple thread safe progress bar and spinner library.
+
+
+
+## Adding to your program
+1. Fetch the package.
+ `zig fetch --save git+https://github.com/BrookJeynes/progress`
+2. Add to your `build.zig`.
+ ```zig
+ const progress = b.dependency("progress", .{}).module("progress");
+ exe.root_module.addImport("progress", progress);
+ ```
+
+## Minimal example
+```zig
+const std = @import("std");
+const ProgressBar = @import("progress").Bar;
+const ProgressSpinner = @import("progress").Spinner;
+
+pub fn bar() !void {
+ const stdout = std.io.getStdOut().writer();
+ var pb = ProgressBar.init(10, stdout.any(), .{});
+
+ while (!pb.isFinished()) {
+ pb.add(1);
+ try pb.render();
+
+ std.time.sleep(std.time.ns_per_ms * 150);
+ }
+}
+
+pub fn spinner() !void {
+ const stdout = std.io.getStdOut().writer();
+ var ps = ProgressSpinner.init(stdout.any(), .{
+ .symbols = ProgressSpinner.PredefinedSymbols.default,
+ });
+
+ var iterations: usize = 0;
+ while (!ps.isFinished()) {
+ iterations += 1;
+ try ps.render();
+
+ if (iterations == 20) try ps.finish();
+
+ std.time.sleep(std.time.ns_per_ms * 150);
+ }
+}
+```
+
+You can find more examples in the `examples/` folder.
+For more information, see the source code or documentation (`zig build docs`).
+
+## Contributing
+Contributions, issues, and feature requests are always welcome! This project is
+using the latest stable release of Zig (0.13.0).
