2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-05-28 18:50:47 +00:00
Commit Graph

122 Commits

Author SHA1 Message Date
Ronan Jouchet
5146dc05e5 README: shorter 2022-05-30 12:26:05 -04:00
Ronan Jouchet
1d56cd77bc README: leftover 2022-05-30 12:23:57 -04:00
Ronan Jouchet
ea0381f226 README: more readable 2022-05-30 10:18:34 -04:00
Ronan Jouchet
b123ebdd77 README: shorter 2022-05-30 09:52:47 -04:00
Ronan Jouchet
4dd92ef060 README: layout 2022-05-30 09:51:43 -04:00
Ronan Jouchet
cbd6ee2c68 README: stop mentioning unmaintained icon repo 2022-05-30 09:51:27 -04:00
Ronan Jouchet
c9c81f5583 README: attempt to be more concise, using gh "details" feature 2022-05-30 09:50:28 -04:00
Ronan Jouchet
339fbfb933 Bump minimum macOS version from 10.9 to 10.10 (see #1404) 2022-04-26 19:40:16 -04:00
Ronan Jouchet
f8bd696e32 README: mention Snap & AUR repos
See https://github.com/nativefier/nativefier/pull/1348
2022-01-31 16:33:53 -05:00
Ronan Jouchet
25c4da6b4d README: more more more more more nits 2022-01-06 14:33:49 -05:00
Ronan Jouchet
1b30ba5cbb README: more more more more nits 2022-01-06 14:32:43 -05:00
Ronan Jouchet
f88244746e README: more more more nits 2022-01-06 14:21:16 -05:00
Ronan Jouchet
8a8a5dd2cc README: more more nits 2022-01-06 14:20:41 -05:00
Ronan Jouchet
37e2f98801 README: more nits 2022-01-06 14:20:12 -05:00
Ronan Jouchet
2445395ad3 README: nits 2022-01-06 14:18:22 -05:00
Ronan Jouchet
8d05fc9b8b Docs: link to Docker Hub repo, lighten README and move some stuff to CATALOG 2022-01-06 14:09:15 -05:00
Peter Lewis
d67f533fa5
README: Update node & npm requirements (#1224)
Update required `node` and `npm` versions to match what's in package.json
2021-06-09 08:14:46 -04:00
Ronan Jouchet
cc02b87de7
Get rid of "docs" folder (#1194)
It contains a weird mix of stuff and hides valuable files from view at the root of the repo. Better to have:
- Docs at the root
- Rest of the github/release-related hodgepodge (screenshots, scripts) in hidden folder .github
2021-05-21 18:16:59 -04:00
Ronan Jouchet
03325b45ce README: remove broken npm badge, and btw useless build status 2021-05-10 10:11:34 -04:00
deciacco
d6f0a28a90
CATALOG.md: build command library (fix #1166) (PR #1178) 2021-05-03 13:08:32 -04:00
Adam Weeden
ec0ea4bd67
README: add troubleshooting section for common issues (#1169)
Per #1112, I'm adding some common troubleshooting steps to the README. As well, this adds a checkbox requesting users to check this section before submitting a ticket, which will hopefully lead to more self-help.
2021-04-29 20:02:43 -04:00
Ronan Jouchet
a19ccd5fda Bump to Electron 12.0.5 with Chrome 89.0.4389.128 2021-04-28 22:05:17 -04:00
Ronan Jouchet
9286fc8086
README: use quotes in example, to divert users from shell globbing pitfalls
Follow-up of https://github.com/nativefier/nativefier/issues/1159#issuecomment-827184112
2021-04-27 18:12:02 -04:00
C. Mangla
cbb4380583
Icon conversion: support GraphicsMagick in addition to ImageMagick (PR #1002)
Co-authored-by: Ronan Jouchet <ronan@jouchet.fr>
2021-02-28 14:21:28 -05:00
Jia Hao
6316d23762 Move to nativefier organization 2021-01-30 04:49:52 +00:00
Ronan Jouchet
f4a7266783 README: more tweaking 2021-01-16 10:19:29 -05:00
Ronan Jouchet
ef43bb6984 README: wording, fix broken links 2021-01-16 10:18:17 -05:00
Ronan Jouchet
fc35b00f88 Make maintenance status (in /releases until now) more visible by putting it at the top of our README 2021-01-16 10:15:51 -05:00
Jia Hao
f2c816795a Actually fix the badge in the README
According to https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/adding-a-workflow-status-badge, we must reference the workflow by name if it contains the `name` keyword.
2020-11-22 02:35:30 +00:00
Jia Hao
125a3894d2 Fix badge in README 2020-11-22 02:30:53 +00:00
Jia Hao
59accaba8d Migrate from Travis CI to GitHub Actions 2020-11-22 02:28:14 +00:00
adasauce
43073cb3f7
README: suggest docker "-rm" flag to clean up containers after build (#1064)
Otherwise it keeps around randomly-named containers forever.
2020-11-05 21:41:42 -05:00
Ronan Jouchet
fd88d5199f Restore & pimp docker docs in README, now that Docker build has been fixed by Jia (thanks Jia) (fix #848) 2020-08-10 21:33:32 -04:00
Ronan Jouchet
30f7aff7a9 README: fix links to bugs & feature requests 2020-07-18 10:30:22 -04:00
Ronan Jouchet
1a36d24597 More README nits 2020-07-18 10:27:56 -04:00
Ronan Jouchet
cc8d65063a Simplify README, move unmaintained docker doc to Dockerfile 2020-07-18 10:19:58 -04:00
Ronan Jouchet
3b344306b0 README: mention Node 10 is required 2020-06-13 10:51:00 -04:00
Ronan Jouchet
dbf12e4f78 README: fix path to images 2020-03-15 17:57:22 -04:00
Ronan Jouchet
c9ee6667d4
Revamp and move to TypeScript (#898)
## Breaking changes

- Require **Node >= 8.10.0 and npm 5.6.0**
- Move to **Electron 8.1.1**.
- That's it. Lots of care went into breaking CLI & programmatic behavior
  as little as possible. **Please report regressions**.
- Known issue: build may fail behind a proxy. Get in touch if you use one:
  https://github.com/jiahaog/nativefier/issues/907#issuecomment-596144768

## Changes summary

Nativefier didn't get much love recently, to the point that it's
becoming hard to run on recent Node, due to old dependencies.
Also, some past practices now seem weird, as better expressible
by modern JS/TS, discouraging contributions including mine.

Addressing this, and one thing leading to another, came a
bigger-than-expected revamp, aiming at making Nativefier more
**lean, stable, future-proof, user-friendly and dev-friendly**,
while **not changing the CLI/programmatic interfaces**. Highlights:

- **Require Node>=8**, as imposed by many of our dependencies. Node 8
  is twice LTS, and easily available even in conservative Linux distros.
  No reason not to demand it.
- **Default to Electron 8**.
- **Bump** all dependencies to latest version, including electron-packager.
- **Move to TS**. TS is great. As of today, I see no reason not to use it,
  and fight interface bugs at runtime rather than at compile time.
  With that, get rid of everything Babel/Webpack.
- **Move away from Gulp**. Gulp's selling point is perf via streaming,
  but for small builds like Nativefier, npm tasks are plenty good
  and less dependency bloat. Gulp was the driver for this PR: broken
  on Node 12, and I didn't feel like just upgrading and keeping it.
- Add tons of **verbose logs** everywhere it makes sense, to have a
  fine & clear trace of the program flow. This will be helpful to
  debug user-reported issues, and already helped me fix a few bugs.
    - With better simple logging, get rid of the quirky and buggy
      progress bar based on package `progress`. Nice logging (minimal
      by default, the verbose logging mentioned above is only used
      when passing `--verbose`) is better and one less dependency.
- **Dump `async` package**, a relic from old callback-hell early Node.
  Also dump a few other micro-packages unnecessary now.
- A first pass of code **cleanup** thanks to modern JS/TS features:
  fixes, simplifications, jsdoc type annotations to types, etc.
- **Remove GitHub integrations Hound & CodeClimate**, which are more
  exotic than good'ol'linters, and whose signal-to-noise ratio is too low.
- Quality: **Add tests** and add **Windows + macOS CI builds**.
  Also, add a **manual test script**, helping to quickly verify the
  hard-to-programatically-test stuff before releases, and limit regressions.
- **Fix a very small number of existing bugs**. The goal of this PR was
  *not* to fix bugs, but to get Nativefier in better shape to do so.
  Bugfixes will come later. Still, these got addressed:
  - Add common `Alt`+`Left`/`Right` for previous/next navigation.
  - Improve #379: fix zoom with `Ctrl` + numpad `+`/`-`
  - Fix pinch-to-zoom (see https://github.com/jiahaog/nativefier/issues/379#issuecomment-598612128 )
2020-03-15 16:50:01 -04:00
Robert Barat
9acd85bb65 README: fix typo (#723) 2018-12-14 08:37:08 -05:00
Ronan Jouchet
1f6e74b1e3
README: fix broken link to changelog 2018-12-01 00:21:32 -05:00
Ronan Jouchet
38edc9191e README: document node 4 is not supported/tested 2018-07-22 13:27:18 -04:00
Ronan Jouchet
eb23217766 README: link to bugs and feature requests, cleanup 2018-07-22 11:49:50 -04:00
chocolateboy
22ef3d39b6 Fix doc typo (#656) 2018-07-20 12:29:37 -04:00
David Kramer
dc257052c5 Fix #199 - macOS: Perform image conversion tasks using sips when available (PR #583)
Eliminates the requirement for imagemagick to be present on macOS for icon conversion.
Based off of the code from PR #279.
2018-04-26 07:42:03 -04:00
Ronan Jouchet
6ac4f33661 Update Dockerfile to node8-alpine, fix typos 2017-11-16 14:08:30 -05:00
ReadmeCritic
952290899e Correct the capitalization of Xcode in README (#459) 2017-10-03 11:44:31 -04:00
Tobias Schneck
95cc30983b Run Nativefier with Docker (#311)
TODO: windows are currently not possible, because of non 64-bit version of `node-rcedit`, see https://github.com/electron/node-rcedit/issues/22. Also there is currently no 32-bit alpine package for wine, what possible solve this image.
2017-05-19 21:21:16 +08:00
Jia Hao Goh
36e34c95a5 Remove $ from docs
This allows shell commands to be copy and pasted easily
2017-04-09 10:36:27 +08:00
Jia Hao Goh
1658db53a6 Document minimum macOS version in docs 2017-04-09 10:35:46 +08:00