Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgeWL authored Nov 21, 2024
1 parent 6575a90 commit 0abdd53
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@ Pet Project to create [Blackout Poetry](https://en.wikipedia.org/wiki/Erasure_(a

https://blackout.georgewl.dev

## Goals
<img src="https://github.com/user-attachments/assets/34f69ab1-9d59-4a20-9bac-65087d6dff8e" width="50%"/>


## Goals
### Must-have
- [X] Create a simple version
- [X] User can select words to be erased - buttons
- [X] Shows in UI the output
Expand All @@ -18,50 +21,56 @@ https://blackout.georgewl.dev
- [X] Add fetch for "Random Text"
- User can now choose between "Random", "Search" and "Manual"
- [ ] "Toggle All" Button
- In many cases will want inverse, instead of toggling off each word, toggling on some of the words
- In many cases will want inverse, instead of manually toggling off each word, toggling on some of the words

## Possible Future Development
### Possible Future Development
- [ ] Save as Image button
- [ ] Copy as Text button
- Should replace blackout words with ⬛
- [ ] Print button
- [ ] Option to filter "Random" by category/theme
- [ ] Option to treat symbols as words
- currently all symbols are stripped from the input text
- [ ] Formatted Text instead of plain text
- [ ] Allow partial selections, rather than only full words
- [ ] Fix the Gutenberg text when bad input
- Some gutenberg text, as the original source was OCR, is formatted wrong, with things like words that are squashed together and symbols attached to words

![image](https://github.com/user-attachments/assets/94b08d83-acfe-4309-9752-1a19cb2328d3)


# Development
## Development

## Recommended IDE Setup
### Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Type Support for `.vue` Imports in TS
### Type Support for `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking.

## Customize configuration
### Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project Setup
### Project Setup

```sh
npm install
```

### Compile and Hot-Reload for Development
#### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production
#### Type-Check, Compile and Minify for Production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)
#### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint
Expand Down

0 comments on commit 0abdd53

Please sign in to comment.