NetNewsWire/README.md

# ![Icon](Technotes/Images/icon.png) NetNewsWire

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FRanchero-Software%2FNetNewsWire%2Fbadge&style=flat)](https://actions-badge.atrox.dev/Ranchero-Software/NetNewsWire/goto)

It’s a free and open source feed reader for macOS. An iOS version is in progress.

It supports [RSS](http://cyber.harvard.edu/rss/rss.html), [Atom](https://tools.ietf.org/html/rfc4287), [JSON Feed](https://jsonfeed.org/), and [RSS-in-JSON](https://github.com/scripting/Scripting-News/blob/master/rss-in-json/README.md) formats.

More info: [https://ranchero.com/netnewswire/](https://ranchero.com/netnewswire/)

Also see the [Technotes](Technotes/) and the [Roadmap](Technotes/Roadmap.md).

Note: NetNewsWire’s Help menu has a bunch of these links, so you don’t have to remember to come back to this page.

Here’s [How to Support NetNewsWire](Technotes/HowToSupportNetNewsWire.markdown). Spoiler: don’t send money. :)

#### Community

[Join the Slack group](https://ranchero.com/netnewswire/slack) to talk with other NetNewsWire users — and to help out, if you’d like to, by testing, coding, writing, providing feedback, or just helping us think things through. Everybody is welcome and encouraged to join.

Every community member is expected to abide by the code of conduct which is included in the [Contributing](CONTRIBUTING.md) page.

#### Pull Requests

See the [Contributing](CONTRIBUTING.md) page for our process. It’s pretty straightforward.

#### Building

```bash
git clone https://github.com/Ranchero-Software/NetNewsWire.git
cd NetNewsWire
git submodule update --init --recursive
```

You can locally override the Xcode settings for code signing
by creating a `DeveloperSettings.xcconfig` file locally at the appropriate path.
This allows for a pristine project with code signing set up with the appropriate
developer ID and certificates, and for dev to be able to have local settings
without needing to check in anything into source control.

As an example, make a directory SharedXcodeSettings next to where you have this repository.
An example of the structure is:

```
aDirectory/
  SharedXcodeSettings/
    DeveloperSettings.xcconfig
  NetNewsWire
    NetNewsWire.xcworkspace
```

Then create a plain text file in it: `SharedXcodeSettings/DeveloperSettings.xcconfig` and
give it the contents:

```
CODE_SIGN_IDENTITY = Mac Developer
DEVELOPMENT_TEAM = <Your Team ID>
CODE_SIGN_STYLE = Automatic
ORGANIZATION_IDENTIFIER = <Your Domain Name Reversed>
PROVISIONING_PROFILE_SPECIFIER =
```

Now you should be able to build without code signing errors and without modifying
the NetNewsWire Xcode project.

Example:

If your NetNewsWire Xcode project file is at:
`/Users/Shared/git/NetNewsWire/NetNewsWire.xcodeproj`

Create your `DeveloperSettings.xcconfig` file at
`/Users/Shared/git/SharedXcodeSettings/DeveloperSettings.xcconfig`
-												Add Images folder in Technotes and updated Technotes/README to point to a couple more files

											
										
										
											2019-06-13 17:23:44 +02:00
+								# ![Icon](Technotes/Images/icon.png) NetNewsWire
-												Update README.

											
										
										
											2017-05-31 18:27:07 +02:00
-												Updates README Github links from brentsimmons to Ranchero-Software
											
										
										
											2020-01-17 20:38:01 +01:00
+								[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FRanchero-Software%2FNetNewsWire%2Fbadge&style=flat)](https://actions-badge.atrox.dev/Ranchero-Software/NetNewsWire/goto)
-												adding technote and readme update for CI

- noting where and how CI is configured
- added current build status to the README for NNW
- referenced submodule builds for a complete view of the current builds
  in the technote

											
										
										
											2019-06-13 16:52:30 +02:00
-												Remove note in README about NNW not yet shipping.

											
										
										
											2019-09-01 07:38:49 +02:00
+								It’s a free and open source feed reader for macOS. An iOS version is in progress.
-												Update README.

											
										
										
											2017-05-31 18:27:07 +02:00
-												Update README to link to the Slack group.

											
										
										
											2019-05-25 19:21:06 +02:00
+								It supports [RSS](http://cyber.harvard.edu/rss/rss.html), [Atom](https://tools.ietf.org/html/rfc4287), [JSON Feed](https://jsonfeed.org/), and [RSS-in-JSON](https://github.com/scripting/Scripting-News/blob/master/rss-in-json/README.md) formats.
-												Update README.

											
										
										
											2017-05-31 18:27:07 +02:00
-												Start renaming to NetNewsWire.

											
										
										
											2018-08-29 06:50:53 +02:00
+								More info: [https://ranchero.com/netnewswire/](https://ranchero.com/netnewswire/)
-												Add link to Technotes in main Readme.

											
										
										
											2017-12-23 23:02:09 +01:00
-												Add link to Roadmap in main Readme.

											
										
										
											2017-12-23 23:04:08 +01:00
+								Also see the [Technotes](Technotes/) and the [Roadmap](Technotes/Roadmap.md).
-												Add note about pull requests.

											
										
										
											2017-12-24 01:39:05 +01:00
-												Update README with note about the Help menu.

											
										
										
											2019-05-25 19:26:37 +02:00
+								Note: NetNewsWire’s Help menu has a bunch of these links, so you don’t have to remember to come back to this page.
-												Add link from README to How to Support NetNewsWire.

											
										
										
											2019-06-14 23:27:16 +02:00
+								Here’s [How to Support NetNewsWire](Technotes/HowToSupportNetNewsWire.markdown). Spoiler: don’t send money. :)
-												Update README to link to the Slack group.

											
										
										
											2019-05-25 19:21:06 +02:00
+								#### Community
-												Update Slack group link to point to link that redirects to the new Slack invitation page.

											
										
										
											2019-09-28 20:31:39 +02:00
+								[Join the Slack group](https://ranchero.com/netnewswire/slack) to talk with other NetNewsWire users — and to help out, if you’d like to, by testing, coding, writing, providing feedback, or just helping us think things through. Everybody is welcome and encouraged to join.
-												Update README to link to the Slack group.

											
										
										
											2019-05-25 19:21:06 +02:00
-												Fixes the link to CONTRIBUTING.md

The link to CONTRIBUTING.md was cased incorrectly and therefore 404'd.
											
										
										
											2019-06-15 02:12:17 +02:00
+								Every community member is expected to abide by the code of conduct which is included in the [Contributing](CONTRIBUTING.md) page.
-												Add note about pull requests.

											
										
										
											2017-12-24 01:39:05 +01:00
-												Update README to link to CONTRIBUTING.

											
										
										
											2019-06-12 07:01:11 +02:00
+								#### Pull Requests
-												Add note about pull requests.

											
										
										
											2017-12-24 01:39:05 +01:00
-												Update README.md

Fixed link to contributing page in README.
											
										
										
											2019-06-17 16:08:09 +02:00
+								See the [Contributing](CONTRIBUTING.md) page for our process. It’s pretty straightforward.
-												Add basic building instructions

I would not have known to look in xcconfig/NetNewsWire_target.xcconfig to find these instructions. I only found them because I was searching around trying to figure out why NetNewsWire wouldn't build for me and found #576. Why not include some instructions in the README?

											
										
										
											2019-05-25 22:45:55 +02:00
 								#### Building
 								```bash
-												Updates README Github links from brentsimmons to Ranchero-Software
											
										
										
											2020-01-17 20:38:01 +01:00
+								git clone https://github.com/Ranchero-Software/NetNewsWire.git
-												Add basic building instructions

I would not have known to look in xcconfig/NetNewsWire_target.xcconfig to find these instructions. I only found them because I was searching around trying to figure out why NetNewsWire wouldn't build for me and found #576. Why not include some instructions in the README?

											
										
										
											2019-05-25 22:45:55 +02:00
+								cd NetNewsWire
-												Correct build instructions

											
										
										
											2019-10-22 20:42:35 +02:00
+								git submodule update --init --recursive
-												Add basic building instructions

I would not have known to look in xcconfig/NetNewsWire_target.xcconfig to find these instructions. I only found them because I was searching around trying to figure out why NetNewsWire wouldn't build for me and found #576. Why not include some instructions in the README?

											
										
										
											2019-05-25 22:45:55 +02:00
+								```
 								You can locally override the Xcode settings for code signing
 								by creating a `DeveloperSettings.xcconfig` file locally at the appropriate path.
 								This allows for a pristine project with code signing set up with the appropriate
 								developer ID and certificates, and for dev to be able to have local settings
 								without needing to check in anything into source control.
-												some minor additional detail on setting up shared dev credentials to support building

											
										
										
											2019-06-19 18:40:19 +02:00
+								As an example, make a directory SharedXcodeSettings next to where you have this repository.
 								An example of the structure is:
 								```
 								aDirectory/
 								  SharedXcodeSettings/
 								    DeveloperSettings.xcconfig
 								  NetNewsWire
-												Fix typo in README. Fix #986.

											
										
										
											2019-09-06 18:04:48 +02:00
+								    NetNewsWire.xcworkspace
-												some minor additional detail on setting up shared dev credentials to support building

											
										
										
											2019-06-19 18:40:19 +02:00
+								```
 								Then create a plain text file in it: `SharedXcodeSettings/DeveloperSettings.xcconfig` and
 								give it the contents:
-												Add basic building instructions

I would not have known to look in xcconfig/NetNewsWire_target.xcconfig to find these instructions. I only found them because I was searching around trying to figure out why NetNewsWire wouldn't build for me and found #576. Why not include some instructions in the README?

											
										
										
											2019-05-25 22:45:55 +02:00
 								```
 								CODE_SIGN_IDENTITY = Mac Developer
 								DEVELOPMENT_TEAM = <Your Team ID>
 								CODE_SIGN_STYLE = Automatic
-												Add new developer setting to configure the organization

											
										
										
											2019-09-19 18:23:57 +02:00
+								ORGANIZATION_IDENTIFIER = <Your Domain Name Reversed>
-												Add basic building instructions

I would not have known to look in xcconfig/NetNewsWire_target.xcconfig to find these instructions. I only found them because I was searching around trying to figure out why NetNewsWire wouldn't build for me and found #576. Why not include some instructions in the README?

											
										
										
											2019-05-25 22:45:55 +02:00
+								PROVISIONING_PROFILE_SPECIFIER =
 								```
 								Now you should be able to build without code signing errors and without modifying
 								the NetNewsWire Xcode project.
 								Example:
 								If your NetNewsWire Xcode project file is at:
 								`/Users/Shared/git/NetNewsWire/NetNewsWire.xcodeproj`
 								Create your `DeveloperSettings.xcconfig` file at
 								`/Users/Shared/git/SharedXcodeSettings/DeveloperSettings.xcconfig`