From f4eb2e0937614b0c1c4dd99387146c3bd0d4649e Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Fri, 16 Nov 2018 09:56:29 +0100 Subject: Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 92de659..c46ef11 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ The `StreamingClap` is base of all the other parsers. It's a streaming parser th ```rust const params = []clap.Param(u8){ - clap.Param(void).flag('h', false, clap.Names.both("help")), - clap.Param(void).option('n', true, clap.Names.both("number")), - clap.Param(void).positional('f'), + clap.Param(u8).flag('h', false, clap.Names.both("help")), + clap.Param(u8).option('n', true, clap.Names.both("number")), + clap.Param(u8).positional('f'), }; var os_iter = clap.args.OsIterator.init(allocator); -- cgit v1.2.3 From d0005fab619a0f8cc92b166f2d40764ab0d3043e Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Tue, 4 Dec 2018 14:48:46 +0100 Subject: Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c46ef11..0d88e53 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ The `StreamingClap` is base of all the other parsers. It's a streaming parser th ```rust const params = []clap.Param(u8){ - clap.Param(u8).flag('h', false, clap.Names.both("help")), - clap.Param(u8).option('n', true, clap.Names.both("number")), + clap.Param(u8).flag('h', clap.Names.both("help")), + clap.Param(u8).option('n', clap.Names.both("number")), clap.Param(u8).positional('f'), }; @@ -50,8 +50,8 @@ them available through three functions (`flag`, `option`, `positionals`). ```rust const params = comptime []clap.Param(void){ - clap.Param(void).flag({}, false, clap.Names.both("help")), - clap.Param(void).option({}, true, clap.Names.both("number")), + clap.Param(void).flag({}, clap.Names.both("help")), + clap.Param(void).option({}, clap.Names.both("number")), clap.Param(void).positional({}), }; @@ -78,7 +78,7 @@ program can take: ```rust const params = comptime []clap.Param(void){ - clap.Param(void).init({}, false, clap.Names.both("help")), + clap.Param(void).flag({}, clap.Names.both("help")), }; var os_iter = clap.args.OsIterator.init(allocator); -- cgit v1.2.3 From 7800f4e2247cbf3eaf5306a7e41ff17130885328 Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Sun, 16 Dec 2018 13:23:40 +0100 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0d88e53..b64ab2b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A simple and easy to use command line argument parser library for Zig. ### `StreamingClap` -The `StreamingClap` is base of all the other parsers. It's a streaming parser that uses an +The `StreamingClap` is the base of all the other parsers. It's a streaming parser that uses an `args.Iterator` to provide it with arguments lazily. ```rust @@ -106,7 +106,7 @@ zig-clap/example/comptime-clap.zig:41:18: note: called from here ^ ``` -Ofc, this limits you to use only parameters that are comptime known. +Ofc, this limits you to parameters that are comptime known. ### `help` -- cgit v1.2.3 From 88a3c8df0a63be509066c81b149c042fbe748c04 Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Thu, 17 Jan 2019 16:02:28 +0100 Subject: Updated readme --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b64ab2b..e16a13d 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,11 @@ const params = []clap.Param(u8){ clap.Param(u8).positional('f'), }; -var os_iter = clap.args.OsIterator.init(allocator); -const iter = &os_iter.iter; -defer os_iter.deinit(); - +var iter = clap.args.OsIterator.init(allocator); +defer iter.deinit(); const exe = try iter.next(); -var parser = clap.StreamingClap(u8, clap.args.OsIterator.Error).init(params, iter); +var parser = clap.StreamingClap(u8, clap.args.OsIterator).init(params, &iter); while (try parser.next()) |arg| { switch (arg.param.id) { @@ -40,7 +38,7 @@ while (try parser.next()) |arg| { 'f' => debug.warn("{}\n", arg.value.?), else => unreachable, } - } +} ``` ### `ComptimeClap` @@ -55,13 +53,11 @@ const params = comptime []clap.Param(void){ clap.Param(void).positional({}), }; -var os_iter = clap.args.OsIterator.init(allocator); -const iter = &os_iter.iter; -defer os_iter.deinit(); - +var iter = clap.args.OsIterator.init(allocator); +defer iter.deinit(); const exe = try iter.next(); -var args = try clap.ComptimeClap(void, params).parse(allocator, clap.args.OsIterator.Error, iter); +var args = try clap.ComptimeClap(void, params).parse(allocator, clap.args.OsIterator, &iter); defer args.deinit(); if (args.flag("--help")) @@ -85,9 +81,11 @@ var os_iter = clap.args.OsIterator.init(allocator); const iter = &os_iter.iter; defer os_iter.deinit(); +var iter = clap.args.OsIterator.init(allocator); +defer iter.deinit(); const exe = try iter.next(); -var args = try clap.ComptimeClap(params).parse(allocator, clap.args.OsIterator.Error, iter); +var args = try clap.ComptimeClap(void, params).parse(allocator, clap.args.OsIterator, &iter); defer args.deinit(); if (args.flag("--helps")) -- cgit v1.2.3 From 7dadceaa13ae493c1a4fb8fee6ea52b49beed287 Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Mon, 21 Jan 2019 09:30:05 +0100 Subject: Removed duplicate in readme --- README.md | 4 ---- 1 file changed, 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e16a13d..8081d84 100644 --- a/README.md +++ b/README.md @@ -77,10 +77,6 @@ const params = comptime []clap.Param(void){ clap.Param(void).flag({}, clap.Names.both("help")), }; -var os_iter = clap.args.OsIterator.init(allocator); -const iter = &os_iter.iter; -defer os_iter.deinit(); - var iter = clap.args.OsIterator.init(allocator); defer iter.deinit(); const exe = try iter.next(); -- cgit v1.2.3