Commit graph

10 commits

Author SHA1 Message Date
Miles Murgaw
3cbe6ff96e
Fix Outdated README.md (#2147)
* fix: outdated readme

* Fix missing readme

---------

Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
2024-03-26 19:17:02 -07:00
TKirishima
48e413a4f3
fix: no project-name in argument of dx create (#1803) 2024-01-09 13:22:38 -06:00
Benjamin Manns
972235bd6f
Fix doc tests by adding formatting to CLI README (#1706)
The README for cli gets included in lib.rs via `include_str!`. The code snippets then get assumed to be Rust, which fails if running `cargo test --doc`. This is not a huge problem, but was brought to my attention because Nix's `buildRustPackage` runs `cargo test` including doc tests (unlike what get run for this project on CI). This means I can't update the Nix package to 0.4.3 without changing the test flags (which I think I'll see about doing anyways, as that's how Dioxus runs CI).
2023-12-10 12:16:59 -06:00
xTeKc
ca556ea9cb
update readme (#1615)
* Fix wasm-bindgen version mismatch

* fixes #1613
2023-11-06 13:32:42 -06:00
Leonard
c65a49fd0f
Remove redundant directories (#1535)
Also fix typo
2023-10-10 09:50:58 -05:00
Marc Espín
95887e836c
fix: Add the --locked param to every cli installation command (#1427) 2023-09-04 07:28:38 -05:00
Leonard
94f76946fc
Improve CLI docs (#1404)
* Improve CLI docs

* Fixed all the typos (hopefully).
* Improved the bad English. This encompasses grammar, vocabulary, generally awkward phrases, etc. The result is easier to read and understand, and in some cases shorter.
* Made some formatting improvements. This includes making formatting more consistent, but I changed some of it to be better, at least in my opinion.
* Removed certain unnecessities, the biggest one being the commands documentation. I think this is unnecessary because of the `dx --help` command. It also needs to be updated every time a command gets added/updated/removed. It doesn't really provide much extra insight than `dx --help`.
* Improved plugin documentation. I added a warning to ignore all of it, which is ironic, but the fact is that plugins are probably going to change. But by the time I learned that, I already made some changes to the plugin docs. This includes a better guide on how to get started (although still bad since the plugin system is too messy), and some general changes like the aforementioned English or formatting.
* And more. I can't list it all, but I didn't use any destructive changes. The content might be reformatted (to be shorter or easier to understand), but the meaning isn't lost.

* Fix grammar in packages/cli/docs/src/creating.md

Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>

* Update README.md

* Change config example

---------

Co-authored-by: Evan Simkowitz <esimkowitz@users.noreply.github.com>
2023-09-02 17:59:20 -05:00
Jonathan Kelley
16763c065b
Rename dioxus to dx in examples and fullstack 2023-07-14 13:53:06 -07:00
Jonathan Kelley
ec0fce3aef Update install location for CLI 2023-06-28 17:39:03 -07:00
Jonathan Kelley
a9d7b4d32a Prepare CLI for move into mainline 2023-06-28 17:21:23 -07:00
Renamed from README.md (Browse further)