Commit graph

14 commits

Author SHA1 Message Date
Will McGugan
3626ace4a6 caps 2024-03-30 15:23:44 +00:00
Will McGugan
cc19158a9a inline docs 2024-03-30 13:21:29 +00:00
Will McGugan
0ad03f3731
Packaging how to (#4031)
* how-to

* how-to

* tweaks

* fix nav

* tweak

* example repository

* fix word

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* definition

* words

* elaborate

* Update docs/how-to/package-with-hatch.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* clarification

* Update docs/how-to/package-with-hatch.md

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Words

* added info

* words

* Update docs/how-to/package-with-hatch.md

Co-authored-by: Darren Burns <darrenburns@users.noreply.github.com>

* words

* ws

* capitalize

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
Co-authored-by: Darren Burns <darrenburns@users.noreply.github.com>
2024-01-17 13:05:26 +00:00
Will McGugan
dbcecda90d
remove how-to (#4020)
* remove how-to

* remove index
2024-01-15 14:33:46 +00:00
Dave Pearson
0bea8b250c
HOWTO package a Textual application (#3977)
* Initial draft of the howto for packaging an application

There's a fair bit more I think needs adding, but this has the core concepts
within it. Things still to decide or do are:

- How much lead-in and hand-holding is needed for Hatch and Poetry

For example, should we walk the reader through the `init` process for Hatch
and Poetry, and then guide them to the correct directory in which to create
their application, etc?

- How to do the example repo

Should I do two repos, one for Hatch and one for Poetry? Or should I do one
repo with a Hatch and a Poetry example within sub-directories? In either
case having a tidy one-to-one relationship with what I talk about in the
text won't be quite right.

Mainly though I feel the core of what's needed is here (and it's not much,
but has taken some testing and checking and whittling down to get here).

* Title tweak

* Add a note about declaring Textual as a dependency

While this might seem obvious, and while some tools will, as a natural
consequence of using them, ensure that this happens, it's worth highlighting
this so that the reader is mindful of this.

Also, someone might be reading the HOWTO while considering how they to this
with their own build system.

* Break paragraphs down into different lines

Just an internal layout thing. Some folk seem to like this sort of thing.

* Add a summary

* Some rewording

* Link to the example repos

* Post-initial-proof-read

* Link to pip and pipx

* Don't repeat help in the same sentence

* Remove an actual needless word

* Remove the dual use of application in a sentence

* Link to TCSS files in case the reader needs a refresh

* Explain what the example repositories were built for/with

It should be obvious from the names; but it can't hurt to be *very* clear.

* Update docs/how-to/package-an-application.md

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Changes in response to feedback

* Trim down the into a wee bit

* Trim down the into a wee bit more

---------

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2024-01-15 10:15:10 +00:00
Will McGugan
2f3809dcff clarification 2023-12-12 15:21:52 +00:00
Will McGugan
bfbc6fb285
added howto (#3854)
* added howto

* don't need this

* don't need this

* move title

* docstring
2023-12-12 14:39:27 +00:00
Will McGugan
64703c04dd
interactive examples (#3418)
* interactive examples

* words

* remove log
2023-09-29 15:23:42 +01:00
dmunozv04
41fe544a1f Fix broken link 2023-08-08 13:38:47 +02:00
dmunozv04
52d0586f5d Fix doc links 2023-08-08 13:27:13 +02:00
Will McGugan
bbe779aede update to center-things howto 2023-08-06 13:24:01 +01:00
Will McGugan
dbd3644577
center how to (#3031)
* center how to

* words

* words
2023-07-31 09:56:46 +01:00
Will McGugan
49e1080279 update howto 2023-05-18 10:03:26 +01:00
Will McGugan
f820598846
How to (#2592)
* words

* how to

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>

---------

Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-05-17 15:30:31 +01:00